

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>Tokenizers &mdash; Openspeech v0.3.0 documentation</title>
  

  
  <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />

  
  

  
  

  

  
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/doctools.js"></script>
        <script src="../_static/language_data.js"></script>
    
    <script type="text/javascript" src="../_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Metric" href="Metric.html" />
    <link rel="prev" title="Search" href="Search.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

          
            <a href="../index.html" class="icon icon-home"> Openspeech
          

          
          </a>

          
            
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <p class="caption"><span class="caption-text">GETTING STARTED</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../notes/intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes/hydra_configs.html">Openspeech’s Hydra configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notes/configs.html">Openspeech’s configurations</a></li>
</ul>
<p class="caption"><span class="caption-text">OPENSPEECH MODELS</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../models/Openspeech Model.html">Openspeech Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../models/Openspeech CTC Model.html">Openspeech CTC Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../models/Openspeech Encoder Decoder Model.html">Openspeech Encoder Decoder Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../models/Openspeech Transducer Model.html">Openspeech Transducer Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../models/Openspeech Language Model.html">Openspeech Language Model</a></li>
</ul>
<p class="caption"><span class="caption-text">MODEL ARCHITECTURES</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../architectures/Conformer.html">Conformer</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architectures/ContextNet.html">ContextNet</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architectures/DeepSpeech2.html">DeepSpeech2</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architectures/Jasper.html">Jasper</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architectures/Listen Attend Spell.html">Listen Attend Spell Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architectures/LSTM LM.html">LSTM Language Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architectures/QuartzNet.html">QuartzNet Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architectures/RNN Transducer.html">RNN Transducer Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architectures/Transformer.html">Transformer Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architectures/Transformer LM.html">Transformer Language Model</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architectures/Transformer Transducer.html">Transformer Transducer Model</a></li>
</ul>
<p class="caption"><span class="caption-text">CORPUS</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../corpus/AISHELL-1.html">AISHELL</a></li>
<li class="toctree-l1"><a class="reference internal" href="../corpus/KsponSpeech.html">KsponSpeech</a></li>
<li class="toctree-l1"><a class="reference internal" href="../corpus/LibriSpeech.html">LibriSpeech</a></li>
</ul>
<p class="caption"><span class="caption-text">LIBRARY REFERENCE</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="Callback.html">Callback</a></li>
<li class="toctree-l1"><a class="reference internal" href="Criterion.html">Criterion</a></li>
<li class="toctree-l1"><a class="reference internal" href="Data Augment.html">Data Augment</a></li>
<li class="toctree-l1"><a class="reference internal" href="Feature Transform.html">Feature Transform</a></li>
<li class="toctree-l1"><a class="reference internal" href="Datasets.html">Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="Data Loaders.html">Data Loaders</a></li>
<li class="toctree-l1"><a class="reference internal" href="Decoders.html">Decoders</a></li>
<li class="toctree-l1"><a class="reference internal" href="Encoders.html">Encoders</a></li>
<li class="toctree-l1"><a class="reference internal" href="Modules.html">Modules</a></li>
<li class="toctree-l1"><a class="reference internal" href="Optim.html">Optim</a></li>
<li class="toctree-l1"><a class="reference internal" href="Search.html">Search</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Tokenizers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#module-openspeech.tokenizers.tokenizer">Tokenizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-openspeech.tokenizers.aishell.character">AISHELL-1 Character Tokenizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-openspeech.tokenizers.ksponspeech.character">KsponSpeech Character Tokenizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-openspeech.tokenizers.ksponspeech.subword">KsponSpeech Subword Tokenizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-openspeech.tokenizers.ksponspeech.grapheme">KsponSpeech Grapheme Tokenizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-openspeech.tokenizers.librispeech.character">LibriSpeech Character Tokenizer</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-openspeech.tokenizers.librispeech.subword">LibriSpeech Subword Tokenizer</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Metric.html">Metric</a></li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">Openspeech</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
        
      <li>Tokenizers</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../_sources/modules/Tokenizers.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="tokenizers">
<h1>Tokenizers<a class="headerlink" href="#tokenizers" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-openspeech.tokenizers.tokenizer">
<span id="tokenizer"></span><h2>Tokenizer<a class="headerlink" href="#module-openspeech.tokenizers.tokenizer" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="openspeech.tokenizers.tokenizer.Tokenizer">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.tokenizer.</code><code class="sig-name descname">Tokenizer</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/tokenizer.html#Tokenizer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.tokenizer.Tokenizer" title="Permalink to this definition">¶</a></dt>
<dd><p>A tokenizer is in charge of preparing the inputs for a model.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Do not use this class directly, use one of the sub classes.</p>
</div>
</dd></dl>

</div>
<div class="section" id="module-openspeech.tokenizers.aishell.character">
<span id="aishell-1-character-tokenizer"></span><h2>AISHELL-1 Character Tokenizer<a class="headerlink" href="#module-openspeech.tokenizers.aishell.character" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="openspeech.tokenizers.aishell.character.AIShellCharacterTokenizer">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.aishell.character.</code><code class="sig-name descname">AIShellCharacterTokenizer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">configs</span><span class="p">:</span> <span class="n">omegaconf.dictconfig.DictConfig</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/aishell/character.html#AIShellCharacterTokenizer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.aishell.character.AIShellCharacterTokenizer" title="Permalink to this definition">¶</a></dt>
<dd><p>Tokenizer class in Character-units for AISHELL.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configs</strong> (<em>DictConfig</em>) – configuration set.</p>
</dd>
</dl>
<dl class="py method">
<dt id="openspeech.tokenizers.aishell.character.AIShellCharacterTokenizer.decode">
<code class="sig-name descname">decode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">labels</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/aishell/character.html#AIShellCharacterTokenizer.decode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.aishell.character.AIShellCharacterTokenizer.decode" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts label to string.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>labels</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.21)"><em>numpy.ndarray</em></a>) – number label</p>
</dd>
</dl>
<dl class="simple">
<dt>Returns: sentence</dt><dd><ul class="simple">
<li><p><strong>sentence</strong> (str or list): symbol of labels</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="openspeech.tokenizers.aishell.character.AIShellCharacterTokenizer.load_vocab">
<code class="sig-name descname">load_vocab</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vocab_path</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="o">=</span><span class="default_value">'utf-8'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/aishell/character.html#AIShellCharacterTokenizer.load_vocab"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.aishell.character.AIShellCharacterTokenizer.load_vocab" title="Permalink to this definition">¶</a></dt>
<dd><p>Provides char2id, id2char</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vocab_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – csv file with character labels</p></li>
<li><p><strong>encoding</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – encoding method</p></li>
</ul>
</dd>
</dl>
<dl class="simple">
<dt>Returns: unit2id, id2unit</dt><dd><ul class="simple">
<li><p><strong>unit2id</strong> (dict): unit2id[unit] = id</p></li>
<li><p><strong>id2unit</strong> (dict): id2unit[id] = unit</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="openspeech.tokenizers.aishell.character.AIShellCharacterTokenizerConfigs">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.aishell.character.</code><code class="sig-name descname">AIShellCharacterTokenizerConfigs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;sos&gt;'</span></em>, <em class="sig-param"><span class="n">eos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;eos&gt;'</span></em>, <em class="sig-param"><span class="n">pad_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;pad&gt;'</span></em>, <em class="sig-param"><span class="n">blank_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;blank&gt;'</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'utf-8'</span></em>, <em class="sig-param"><span class="n">unit</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'aishell_character'</span></em>, <em class="sig-param"><span class="n">vocab_path</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'../../../data_aishell/aishell_labels.csv'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/aishell/character.html#AIShellCharacterTokenizerConfigs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.aishell.character.AIShellCharacterTokenizerConfigs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-openspeech.tokenizers.ksponspeech.character">
<span id="ksponspeech-character-tokenizer"></span><h2>KsponSpeech Character Tokenizer<a class="headerlink" href="#module-openspeech.tokenizers.ksponspeech.character" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="openspeech.tokenizers.ksponspeech.character.KsponSpeechCharacterTokenizer">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.ksponspeech.character.</code><code class="sig-name descname">KsponSpeechCharacterTokenizer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">configs</span><span class="p">:</span> <span class="n">omegaconf.dictconfig.DictConfig</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/character.html#KsponSpeechCharacterTokenizer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.character.KsponSpeechCharacterTokenizer" title="Permalink to this definition">¶</a></dt>
<dd><p>Tokenizer class in Character-units for KsponSpeech.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configs</strong> (<em>DictConfig</em>) – configuration set.</p>
</dd>
</dl>
<dl class="py method">
<dt id="openspeech.tokenizers.ksponspeech.character.KsponSpeechCharacterTokenizer.decode">
<code class="sig-name descname">decode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">labels</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/character.html#KsponSpeechCharacterTokenizer.decode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.character.KsponSpeechCharacterTokenizer.decode" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts label to string (number =&gt; Hangeul)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>labels</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.21)"><em>numpy.ndarray</em></a>) – number label</p>
</dd>
</dl>
<dl class="simple">
<dt>Returns: sentence</dt><dd><ul class="simple">
<li><p><strong>sentence</strong> (str or list): symbol of labels</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="openspeech.tokenizers.ksponspeech.character.KsponSpeechCharacterTokenizer.load_vocab">
<code class="sig-name descname">load_vocab</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vocab_path</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="o">=</span><span class="default_value">'utf-8'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/character.html#KsponSpeechCharacterTokenizer.load_vocab"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.character.KsponSpeechCharacterTokenizer.load_vocab" title="Permalink to this definition">¶</a></dt>
<dd><p>Provides char2id, id2char</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vocab_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – csv file with character labels</p></li>
<li><p><strong>encoding</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – encoding method</p></li>
</ul>
</dd>
</dl>
<dl class="simple">
<dt>Returns: unit2id, id2unit</dt><dd><ul class="simple">
<li><p><strong>unit2id</strong> (dict): unit2id[unit] = id</p></li>
<li><p><strong>id2unit</strong> (dict): id2unit[id] = unit</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="openspeech.tokenizers.ksponspeech.character.KsponSpeechCharacterTokenizerConfigs">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.ksponspeech.character.</code><code class="sig-name descname">KsponSpeechCharacterTokenizerConfigs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;sos&gt;'</span></em>, <em class="sig-param"><span class="n">eos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;eos&gt;'</span></em>, <em class="sig-param"><span class="n">pad_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;pad&gt;'</span></em>, <em class="sig-param"><span class="n">blank_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;blank&gt;'</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'utf-8'</span></em>, <em class="sig-param"><span class="n">unit</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'kspon_character'</span></em>, <em class="sig-param"><span class="n">vocab_path</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'../../../aihub_labels.csv'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/character.html#KsponSpeechCharacterTokenizerConfigs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.character.KsponSpeechCharacterTokenizerConfigs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-openspeech.tokenizers.ksponspeech.subword">
<span id="ksponspeech-subword-tokenizer"></span><h2>KsponSpeech Subword Tokenizer<a class="headerlink" href="#module-openspeech.tokenizers.ksponspeech.subword" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="openspeech.tokenizers.ksponspeech.subword.KsponSpeechSubwordTokenizer">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.ksponspeech.subword.</code><code class="sig-name descname">KsponSpeechSubwordTokenizer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">configs</span><span class="p">:</span> <span class="n">omegaconf.dictconfig.DictConfig</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/subword.html#KsponSpeechSubwordTokenizer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.subword.KsponSpeechSubwordTokenizer" title="Permalink to this definition">¶</a></dt>
<dd><p>Tokenizer class in Subword-units for KsponSpeech.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configs</strong> (<em>DictConfig</em>) – configuration set.</p>
</dd>
</dl>
<dl class="py method">
<dt id="openspeech.tokenizers.ksponspeech.subword.KsponSpeechSubwordTokenizer.decode">
<code class="sig-name descname">decode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">labels</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/subword.html#KsponSpeechSubwordTokenizer.decode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.subword.KsponSpeechSubwordTokenizer.decode" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts label to string (number =&gt; Hangeul)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>labels</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.21)"><em>numpy.ndarray</em></a>) – number label</p>
</dd>
</dl>
<dl class="simple">
<dt>Returns: sentence</dt><dd><ul class="simple">
<li><p><strong>sentence</strong> (str or list): symbol of labels</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="openspeech.tokenizers.ksponspeech.subword.KsponSpeechSubwordTokenizerConfigs">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.ksponspeech.subword.</code><code class="sig-name descname">KsponSpeechSubwordTokenizerConfigs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;s&gt;'</span></em>, <em class="sig-param"><span class="n">eos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;/s&gt;'</span></em>, <em class="sig-param"><span class="n">pad_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;pad&gt;'</span></em>, <em class="sig-param"><span class="n">blank_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;blank&gt;'</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'utf-8'</span></em>, <em class="sig-param"><span class="n">unit</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'kspon_subword'</span></em>, <em class="sig-param"><span class="n">sp_model_path</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'sp.model'</span></em>, <em class="sig-param"><span class="n">vocab_size</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)">int</a></span> <span class="o">=</span> <span class="default_value">3200</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/subword.html#KsponSpeechSubwordTokenizerConfigs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.subword.KsponSpeechSubwordTokenizerConfigs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-openspeech.tokenizers.ksponspeech.grapheme">
<span id="ksponspeech-grapheme-tokenizer"></span><h2>KsponSpeech Grapheme Tokenizer<a class="headerlink" href="#module-openspeech.tokenizers.ksponspeech.grapheme" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="openspeech.tokenizers.ksponspeech.grapheme.KsponSpeechGraphemeTokenizer">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.ksponspeech.grapheme.</code><code class="sig-name descname">KsponSpeechGraphemeTokenizer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">configs</span><span class="p">:</span> <span class="n">omegaconf.dictconfig.DictConfig</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/grapheme.html#KsponSpeechGraphemeTokenizer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.grapheme.KsponSpeechGraphemeTokenizer" title="Permalink to this definition">¶</a></dt>
<dd><p>Tokenizer class in Grapheme-units for KsponSpeech.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configs</strong> (<em>DictConfig</em>) – configuration set.</p>
</dd>
</dl>
<dl class="py method">
<dt id="openspeech.tokenizers.ksponspeech.grapheme.KsponSpeechGraphemeTokenizer.decode">
<code class="sig-name descname">decode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">labels</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/grapheme.html#KsponSpeechGraphemeTokenizer.decode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.grapheme.KsponSpeechGraphemeTokenizer.decode" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts label to string (number =&gt; Hangeul)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>labels</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.21)"><em>numpy.ndarray</em></a>) – number label</p>
</dd>
</dl>
<dl class="simple">
<dt>Returns: sentence</dt><dd><ul class="simple">
<li><p><strong>sentence</strong> (str or list): symbol of labels</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="openspeech.tokenizers.ksponspeech.grapheme.KsponSpeechGraphemeTokenizer.load_vocab">
<code class="sig-name descname">load_vocab</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vocab_path</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="o">=</span><span class="default_value">'utf-8'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/grapheme.html#KsponSpeechGraphemeTokenizer.load_vocab"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.grapheme.KsponSpeechGraphemeTokenizer.load_vocab" title="Permalink to this definition">¶</a></dt>
<dd><p>Provides char2id, id2char</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vocab_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – csv file with character labels</p></li>
<li><p><strong>encoding</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – encoding method</p></li>
</ul>
</dd>
</dl>
<dl class="simple">
<dt>Returns: unit2id, id2unit</dt><dd><ul class="simple">
<li><p><strong>unit2id</strong> (dict): unit2id[unit] = id</p></li>
<li><p><strong>id2unit</strong> (dict): id2unit[id] = unit</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="openspeech.tokenizers.ksponspeech.grapheme.KsponSpeechGraphemeTokenizerConfigs">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.ksponspeech.grapheme.</code><code class="sig-name descname">KsponSpeechGraphemeTokenizerConfigs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;sos&gt;'</span></em>, <em class="sig-param"><span class="n">eos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;eos&gt;'</span></em>, <em class="sig-param"><span class="n">pad_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;pad&gt;'</span></em>, <em class="sig-param"><span class="n">blank_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;blank&gt;'</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'utf-8'</span></em>, <em class="sig-param"><span class="n">unit</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'kspon_grapheme'</span></em>, <em class="sig-param"><span class="n">vocab_path</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'../../../aihub_labels.csv'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/ksponspeech/grapheme.html#KsponSpeechGraphemeTokenizerConfigs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.ksponspeech.grapheme.KsponSpeechGraphemeTokenizerConfigs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-openspeech.tokenizers.librispeech.character">
<span id="librispeech-character-tokenizer"></span><h2>LibriSpeech Character Tokenizer<a class="headerlink" href="#module-openspeech.tokenizers.librispeech.character" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="openspeech.tokenizers.librispeech.character.LibriSpeechCharacterTokenizer">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.librispeech.character.</code><code class="sig-name descname">LibriSpeechCharacterTokenizer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">configs</span><span class="p">:</span> <span class="n">omegaconf.dictconfig.DictConfig</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/librispeech/character.html#LibriSpeechCharacterTokenizer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.librispeech.character.LibriSpeechCharacterTokenizer" title="Permalink to this definition">¶</a></dt>
<dd><p>Tokenizer class in Character-units for LibriSpeech.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configs</strong> (<em>DictConfig</em>) – configuration set.</p>
</dd>
</dl>
<dl class="py method">
<dt id="openspeech.tokenizers.librispeech.character.LibriSpeechCharacterTokenizer.decode">
<code class="sig-name descname">decode</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">labels</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/librispeech/character.html#LibriSpeechCharacterTokenizer.decode"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.librispeech.character.LibriSpeechCharacterTokenizer.decode" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts label to string (number =&gt; Hangeul)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>labels</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.21)"><em>numpy.ndarray</em></a>) – number label</p>
</dd>
</dl>
<dl class="simple">
<dt>Returns: sentence</dt><dd><ul class="simple">
<li><p><strong>sentence</strong> (str or list): symbol of labels</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt id="openspeech.tokenizers.librispeech.character.LibriSpeechCharacterTokenizer.load_vocab">
<code class="sig-name descname">load_vocab</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">vocab_path</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="o">=</span><span class="default_value">'utf-8'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/librispeech/character.html#LibriSpeechCharacterTokenizer.load_vocab"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.librispeech.character.LibriSpeechCharacterTokenizer.load_vocab" title="Permalink to this definition">¶</a></dt>
<dd><p>Provides char2id, id2char</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>vocab_path</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – csv file with character labels</p></li>
<li><p><strong>encoding</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)"><em>str</em></a>) – encoding method</p></li>
</ul>
</dd>
</dl>
<dl class="simple">
<dt>Returns: unit2id, id2unit</dt><dd><ul class="simple">
<li><p><strong>unit2id</strong> (dict): unit2id[unit] = id</p></li>
<li><p><strong>id2unit</strong> (dict): id2unit[id] = unit</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt id="openspeech.tokenizers.librispeech.character.LibriSpeechCharacterTokenizerConfigs">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.librispeech.character.</code><code class="sig-name descname">LibriSpeechCharacterTokenizerConfigs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;sos&gt;'</span></em>, <em class="sig-param"><span class="n">eos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;eos&gt;'</span></em>, <em class="sig-param"><span class="n">pad_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;pad&gt;'</span></em>, <em class="sig-param"><span class="n">blank_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;blank&gt;'</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'utf-8'</span></em>, <em class="sig-param"><span class="n">unit</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'libri_character'</span></em>, <em class="sig-param"><span class="n">vocab_path</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'../../../LibriSpeech/libri_labels.csv'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/librispeech/character.html#LibriSpeechCharacterTokenizerConfigs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.librispeech.character.LibriSpeechCharacterTokenizerConfigs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
<div class="section" id="module-openspeech.tokenizers.librispeech.subword">
<span id="librispeech-subword-tokenizer"></span><h2>LibriSpeech Subword Tokenizer<a class="headerlink" href="#module-openspeech.tokenizers.librispeech.subword" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt id="openspeech.tokenizers.librispeech.subword.LibriSpeechSubwordTokenizer">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.librispeech.subword.</code><code class="sig-name descname">LibriSpeechSubwordTokenizer</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">configs</span><span class="p">:</span> <span class="n">omegaconf.dictconfig.DictConfig</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/librispeech/subword.html#LibriSpeechSubwordTokenizer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.librispeech.subword.LibriSpeechSubwordTokenizer" title="Permalink to this definition">¶</a></dt>
<dd><p>Tokenizer class in Subword-units for LibriSpeech.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>configs</strong> (<em>DictConfig</em>) – configuration set.</p>
</dd>
</dl>
</dd></dl>

<dl class="py class">
<dt id="openspeech.tokenizers.librispeech.subword.LibriSpeechSubwordTokenizerConfigs">
<em class="property">class </em><code class="sig-prename descclassname">openspeech.tokenizers.librispeech.subword.</code><code class="sig-name descname">LibriSpeechSubwordTokenizerConfigs</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;s&gt;'</span></em>, <em class="sig-param"><span class="n">eos_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;/s&gt;'</span></em>, <em class="sig-param"><span class="n">pad_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;pad&gt;'</span></em>, <em class="sig-param"><span class="n">blank_token</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'&lt;blank&gt;'</span></em>, <em class="sig-param"><span class="n">encoding</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'utf-8'</span></em>, <em class="sig-param"><span class="n">unit</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'libri_subword'</span></em>, <em class="sig-param"><span class="n">vocab_size</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.9)">int</a></span> <span class="o">=</span> <span class="default_value">5000</span></em>, <em class="sig-param"><span class="n">vocab_path</span><span class="p">:</span> <span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.9)">str</a></span> <span class="o">=</span> <span class="default_value">'../../../LibriSpeech/'</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/openspeech/tokenizers/librispeech/subword.html#LibriSpeechSubwordTokenizerConfigs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#openspeech.tokenizers.librispeech.subword.LibriSpeechSubwordTokenizerConfigs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</div>
</div>


           </div>
           
          </div>
          <footer>
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
        <a href="Metric.html" class="btn btn-neutral float-right" title="Metric" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
        <a href="Search.html" class="btn btn-neutral float-left" title="Search" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; Copyright 2021, Kim, Soohwan and Ha, Sangchun and Cho, Soyoung.

    </p>
  </div>
    
    
    
    Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    
    provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>